home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / g_man / cat3 / OpenGL / glxgetfbconfigattrib.z / glxgetfbconfigattrib
Encoding:
Text File  |  2002-10-03  |  21.3 KB  |  265 lines
  1.  
  2.  
  3.  
  4. ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))    OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee ---- GGGGLLLLXXXX    ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb - return information about a GLX frame buffer
  10.      configuraton
  11.  
  12.  
  13. CCCC SSSSPPPPEEEECCCCIIIIFFFFIIIICCCCAAAATTTTIIIIOOOONNNN
  14.      int ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb( Display *_d_p_y,
  15.                                GLXFBConfig _c_o_n_f_i_g,
  16.                                int _a_t_t_r_i_b_u_t_e,
  17.                                int *_v_a_l_u_e )
  18.  
  19.  
  20. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  21.      _d_p_y        Specifies the connection to the X server.
  22.  
  23.      _c_o_n_f_i_g     Specifies the GLX frame buffer configuration to be queried.
  24.  
  25.      _a_t_t_r_i_b_u_t_e  Specifies the attribute to be returned.
  26.  
  27.      _v_a_l_u_e      Returns the requested value.
  28.  
  29. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  30.      ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb sets _v_a_l_u_e to the _a_t_t_r_i_b_u_t_e value of GLX drawables
  31.      created with respect to _c_o_n_f_i_g.  ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb returns an error
  32.      code if it fails for any reason.  Otherwise, SSSSuuuucccccccceeeessssssss is returned.
  33.  
  34.      _a_t_t_r_i_b_u_t_e is one of the following:
  35.  
  36.      GGGGLLLLXXXX____FFFFBBBBCCCCOOOONNNNFFFFIIIIGGGG____IIIIDDDD       XID of the given GLXFBConfig.
  37.  
  38.      GGGGLLLLXXXX____BBBBUUUUFFFFFFFFEEEERRRR____SSSSIIIIZZZZEEEE       Number of bits per color buffer.  If the frame
  39.                            buffer configuration supports RGBA contexts, then
  40.                            GGGGLLLLXXXX____BBBBUUUUFFFFFFFFEEEERRRR____SSSSIIIIZZZZEEEE is the sum of GGGGLLLLXXXX____RRRREEEEDDDD____SSSSIIIIZZZZEEEE,
  41.                            GGGGLLLLXXXX____GGGGRRRREEEEEEEENNNN____SSSSIIIIZZZZEEEE, GGGGLLLLXXXX____BBBBLLLLUUUUEEEE____SSSSIIIIZZZZEEEE, and GGGGLLLLXXXX____AAAALLLLPPPPHHHHAAAA____SSSSIIIIZZZZEEEE.
  42.                            If the frame buffer configuration supports only
  43.                            color index contexts, GGGGLLLLXXXX____BBBBUUUUFFFFFFFFEEEERRRR____SSSSIIIIZZZZEEEE is the size
  44.                            of the color indexes.
  45.  
  46.      GGGGLLLLXXXX____LLLLEEEEVVVVEEEELLLL             Frame buffer level of the configuration.  Level
  47.                            zero is the default frame buffer.  Positive levels
  48.                            correspond to frame buffers that overlay the
  49.                            default buffer, and negative levels correspond to
  50.                            frame buffers that underlie the default buffer.
  51.  
  52.      GGGGLLLLXXXX____DDDDOOOOUUUUBBBBLLLLEEEEBBBBUUUUFFFFFFFFEEEERRRR      TTTTrrrruuuueeee if color buffers exist in front/back pairs
  53.                            that can be swapped, FFFFaaaallllsssseeee otherwise.
  54.  
  55.      GGGGLLLLXXXX____SSSSTTTTEEEERRRREEEEOOOO            TTTTrrrruuuueeee if color buffers exist in left/right pairs,
  56.                            FFFFaaaallllsssseeee otherwise.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))    OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee ---- GGGGLLLLXXXX    ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))
  71.  
  72.  
  73.  
  74.      GGGGLLLLXXXX____AAAAUUUUXXXX____BBBBUUUUFFFFFFFFEEEERRRRSSSS       Number of auxiliary color buffers that are
  75.                            available.  Zero indicates that no auxiliary color
  76.                            buffers exist.
  77.  
  78.      GGGGLLLLXXXX____RRRREEEEDDDD____SSSSIIIIZZZZEEEE          Number of bits of red stored in each color buffer.
  79.                            Undefined if RGBA contexts are not supported by the
  80.                            frame buffer configuration.
  81.  
  82.      GGGGLLLLXXXX____GGGGRRRREEEEEEEENNNN____SSSSIIIIZZZZEEEE        Number of bits of green stored in each color
  83.                            buffer.  Undefined if RGBA contexts are not
  84.                            supported by the frame buffer configuration.
  85.  
  86.      GGGGLLLLXXXX____BBBBLLLLUUUUEEEE____SSSSIIIIZZZZEEEE         Number of bits of blue stored in each color buffer.
  87.                            Undefined if RGBA contexts are not supported by the
  88.                            frame buffer configuration.
  89.  
  90.      GGGGLLLLXXXX____AAAALLLLPPPPHHHHAAAA____SSSSIIIIZZZZEEEE        Number of bits of alpha stored in each color
  91.                            buffer.  Undefined if RGBA contexts are not
  92.                            supported by the frame buffer configuration.
  93.  
  94.      GGGGLLLLXXXX____DDDDEEEEPPPPTTTTHHHH____SSSSIIIIZZZZEEEE        Number of bits in the depth buffer.
  95.  
  96.      GGGGLLLLXXXX____SSSSTTTTEEEENNNNCCCCIIIILLLL____SSSSIIIIZZZZEEEE      Number of bits in the stencil buffer.
  97.  
  98.      GGGGLLLLXXXX____AAAACCCCCCCCUUUUMMMM____RRRREEEEDDDD____SSSSIIIIZZZZEEEE    Number of bits of red stored in the accumulation
  99.                            buffer.
  100.  
  101.      GGGGLLLLXXXX____AAAACCCCCCCCUUUUMMMM____GGGGRRRREEEEEEEENNNN____SSSSIIIIZZZZEEEE  Number of bits of green stored in the accumulation
  102.                            buffer.
  103.  
  104.      GGGGLLLLXXXX____AAAACCCCCCCCUUUUMMMM____BBBBLLLLUUUUEEEE____SSSSIIIIZZZZEEEE   Number of bits of blue stored in the accumulation
  105.                            buffer.
  106.  
  107.      GGGGLLLLXXXX____AAAACCCCCCCCUUUUMMMM____AAAALLLLPPPPHHHHAAAA____SSSSIIIIZZZZEEEE  Number of bits of alpha stored in the accumulation
  108.                            buffer.
  109.  
  110.      GGGGLLLLXXXX____RRRREEEENNNNDDDDEEEERRRR____TTTTYYYYPPPPEEEE       Mask indicating what type of GLX contexts can be
  111.                            made current to the frame buffer configuration.
  112.                            Valid bits are GGGGLLLLXXXX____RRRRGGGGBBBBAAAA____BBBBIIIITTTT and
  113.                            GGGGLLLLXXXX____CCCCOOOOLLLLOOOORRRR____IIIINNNNDDDDEEEEXXXX____BBBBIIIITTTT.
  114.  
  115.      GGGGLLLLXXXX____DDDDRRRRAAAAWWWWAAAABBBBLLLLEEEE____TTTTYYYYPPPPEEEE     Mask indicating what drawable types the frame
  116.                            buffer configuration supports. Valid bits are
  117.                            GGGGLLLLXXXX____WWWWIIIINNNNDDDDOOOOWWWW____BBBBIIIITTTT, GGGGLLLLXXXX____PPPPIIIIXXXXMMMMAAAAPPPP____BBBBIIIITTTT, and
  118.                            GGGGLLLLXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____BBBBIIIITTTT.
  119.  
  120.      GGGGLLLLXXXX____XXXX____RRRREEEENNNNDDDDEEEERRRRAAAABBBBLLLLEEEE      TTTTrrrruuuueeee if drawables created with the frame buffer
  121.                            configuration can be rendered to by X.
  122.  
  123.      GGGGLLLLXXXX____VVVVIIIISSSSUUUUAAAALLLL____IIIIDDDD         XID of the corresponding visual, or zero if there
  124.                            is no associated visual (i.e., if GGGGLLLLXXXX____XXXX____RRRREEEENNNNDDDDEEEERRRRAAAABBBBLLLLEEEE
  125.                            is FFFFaaaallllsssseeee or GGGGLLLLXXXX____DDDDRRRRAAAAWWWWAAAABBBBLLLLEEEE____TTTTYYYYPPPPEEEE does not have the
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))    OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee ---- GGGGLLLLXXXX    ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))
  137.  
  138.  
  139.  
  140.                            GGGGLLLLXXXX____WWWWIIIINNNNDDDDOOOOWWWW____BBBBIIIITTTT bit set.)
  141.  
  142.      GGGGLLLLXXXX____XXXX____VVVVIIIISSSSUUUUAAAALLLL____TTTTYYYYPPPPEEEE     Visual type of associated visual. The returned
  143.                            value will be one of:  GGGGLLLLXXXX____TTTTRRRRUUUUEEEE____CCCCOOOOLLLLOOOORRRR,
  144.                            GGGGLLLLXXXX____DDDDIIIIRRRREEEECCCCTTTT____CCCCOOOOLLLLOOOORRRR, GGGGLLLLXXXX____PPPPSSSSEEEEUUUUDDDDOOOO____CCCCOOOOLLLLOOOORRRR,
  145.                            GGGGLLLLXXXX____SSSSTTTTAAAATTTTIIIICCCC____CCCCOOOOLLLLOOOORRRR, GGGGLLLLXXXX____GGGGRRRRAAAAYYYY____SSSSCCCCAAAALLLLEEEE, GGGGLLLLXXXX____SSSSTTTTAAAATTTTIIIICCCC____GGGGRRRRAAAAYYYY,
  146.                            or GGGGLLLLXXXX____NNNNOOOONNNNEEEE, if there is no associated visual
  147.                            (i.e., if GGGGLLLLXXXX____XXXX____RRRREEEENNNNDDDDEEEERRRRAAAABBBBLLLLEEEE is FFFFaaaallllsssseeee or
  148.                            GGGGLLLLXXXX____DDDDRRRRAAAAWWWWAAAABBBBLLLLEEEE____TTTTYYYYPPPPEEEE does not have the GGGGLLLLXXXX____WWWWIIIINNNNDDDDOOOOWWWW____BBBBIIIITTTT
  149.                            bit set.)
  150.  
  151.      GGGGLLLLXXXX____CCCCOOOONNNNFFFFIIIIGGGG____CCCCAAAAVVVVEEEEAAAATTTT     One of GGGGLLLLXXXX____NNNNOOOONNNNEEEE, GGGGLLLLXXXX____SSSSLLLLOOOOWWWW____CCCCOOOONNNNFFFFIIIIGGGG, or
  152.                            GGGGLLLLXXXX____NNNNOOOONNNN____CCCCOOOONNNNFFFFOOOORRRRMMMMAAAANNNNTTTT____CCCCOOOONNNNFFFFIIIIGGGG, indicating that the
  153.                            frame buffer configuration has no caveats, some
  154.                            aspect of the frame buffer configuration runs
  155.                            slower than other frame buffer configurations, or
  156.                            some aspect of the frame buffer configuration is
  157.                            nonconformant, respectively.
  158.  
  159.      GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____TTTTYYYYPPPPEEEE  One of GGGGLLLLXXXX____NNNNOOOONNNNEEEE, GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____RRRRGGGGBBBB,
  160.                            GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____IIIINNNNDDDDEEEEXXXX, indicating that the frame
  161.                            buffer configuration is opaque, is transparent for
  162.                            particular values of red, green, and blue or is
  163.                            transparent for particular index values,
  164.                            respectively.
  165.  
  166.      GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____IIIINNNNDDDDEEEEXXXX____VVVVAAAALLLLUUUUEEEE
  167.                            Integer value between 0 and the maximum frame
  168.                            buffer value for indices, indicating the
  169.                            transparent index value for the frame buffer
  170.                            configuration. Undefined if GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____TTTTYYYYPPPPEEEE is
  171.                            not GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____IIIINNNNDDDDEEEEXXXX.
  172.  
  173.      GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____RRRREEEEDDDD____VVVVAAAALLLLUUUUEEEE
  174.                            Integer value between 0 and the maximum frame
  175.                            buffer value for red, indicating the transparent
  176.                            red value for the frame buffer configuration.
  177.                            Undefined if GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____TTTTYYYYPPPPEEEE is not
  178.                            GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____RRRRGGGGBBBB.
  179.  
  180.      GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____GGGGRRRREEEEEEEENNNN____VVVVAAAALLLLUUUUEEEE
  181.                            Integer value between 0 and the maximum frame
  182.                            buffer value for green, indicating the transparent
  183.                            green value for the frame buffer configuration.
  184.                            Undefined if GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____TTTTYYYYPPPPEEEE is not
  185.                            GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____RRRRGGGGBBBB.
  186.  
  187.      GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____BBBBLLLLUUUUEEEE____VVVVAAAALLLLUUUUEEEE
  188.                            Integer value between 0 and the maximum frame
  189.                            buffer value for blue, indicating the transparent
  190.                            blue value for the frame buffer configuration.
  191.                            Undefined if GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____TTTTYYYYPPPPEEEE is not
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))    OOOOppppeeeennnnGGGGLLLL RRRReeeeffffeeeerrrreeeennnncccceeee ---- GGGGLLLLXXXX    ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb((((3333GGGG))))
  203.  
  204.  
  205.  
  206.                            GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____RRRRGGGGBBBB.
  207.  
  208.      GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____AAAALLLLPPPPHHHHAAAA____VVVVAAAALLLLUUUUEEEE
  209.                            Integer value between 0 and the maximum frame
  210.                            buffer value for alpha, indicating the transparent
  211.                            blue value for the frame buffer configuration.
  212.                            Undefined if GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____TTTTYYYYPPPPEEEE is not
  213.                            GGGGLLLLXXXX____TTTTRRRRAAAANNNNSSSSPPPPAAAARRRREEEENNNNTTTT____RRRRGGGGBBBB.
  214.  
  215.      GGGGLLLLXXXX____MMMMAAAAXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____WWWWIIIIDDDDTTTTHHHH The maximum width that can be specified to
  216.                            ggggllllXXXXCCCCrrrreeeeaaaatttteeeeGGGGLLLLXXXXPPPPbbbbuuuuffffffffeeeerrrr.
  217.  
  218.      GGGGLLLLXXXX____MMMMAAAAXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____HHHHEEEEIIIIGGGGHHHHTTTT
  219.                            The maximum height that can be specified to
  220.                            ggggllllXXXXCCCCrrrreeeeaaaatttteeeeGGGGLLLLXXXXPPPPbbbbuuuuffffffffeeeerrrr.
  221.  
  222.      GGGGLLLLXXXX____MMMMAAAAXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____PPPPIIIIXXXXEEEELLLLSSSS
  223.                            The maximum number of pixels (width times height)
  224.                            for a pixel buffer. Note that this value may be
  225.                            less than GGGGLLLLXXXX____MMMMAAAAXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____WWWWIIIIDDDDTTTTHHHH times
  226.                            GGGGLLLLXXXX____MMMMAAAAXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____HHHHEEEEIIIIGGGGHHHHTTTT. Also, this value is static
  227.                            and assumes that no other pixel buffers or X
  228.                            resources are contending for the frame buffer
  229.                            memory. As a result, it may not be possible to
  230.                            allocate a pixel buffer of the size given by
  231.                            GGGGLLLLXXXX____MMMMAAAAXXXX____PPPPBBBBUUUUFFFFFFFFEEEERRRR____PPPPIIIIXXXXEEEELLLLSSSS.
  232.  
  233.      Applications should choose the frame buffer configuration that most
  234.      closely meets their requirements.  Creating windows, GLX pixmaps, or GLX
  235.      pixel buffers with unnecessary buffers can result in reduced rendering
  236.      performance as well as poor resource allocation.
  237.  
  238. NNNNOOOOTTTTEEEESSSS
  239.      ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggAAAAttttttttrrrriiiibbbb is available only if the GLX version is 1.3 or
  240.      greater.
  241.  
  242.      If the GLX version is 1.1 or 1.0, the GL version must be 1.0.  If the GLX
  243.      version is 1.2, then the GL version must be 1.1.  If the GLX version is
  244.      1.3, then the GL version must be 1.2.
  245.  
  246. EEEERRRRRRRROOOORRRRSSSS
  247.      GGGGLLLLXXXX____NNNNOOOO____EEEEXXXXTTTTEEEENNNNSSSSIIIIOOOONNNN is returned if _d_p_y does not support the GLX extension.
  248.      GGGGLLLLXXXX____BBBBAAAADDDD____AAAATTTTTTTTRRRRIIIIBBBBUUUUTTTTEEEE is returned if _a_t_t_r_i_b_u_t_e is not a valid GLX attribute.
  249.  
  250.  
  251. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  252.      ggggllllXXXXGGGGeeeettttFFFFBBBBCCCCoooonnnnffffiiiiggggssss, ggggllllXXXXCCCChhhhoooooooosssseeeeFFFFBBBBCCCCoooonnnnffffiiiigggg, ggggllllXXXXGGGGeeeettttVVVViiiissssuuuuaaaallllFFFFrrrroooommmmFFFFBBBBCCCCoooonnnnffffiiiigggg,
  253.      ggggllllXXXXGGGGeeeettttCCCCoooonnnnffffiiiigggg
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.